Purview Share Client (preview:2021-09-01)

2025/12/05 • 31 new methods

Assets_List (new)
Description :  List assets on a sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/assets
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Assets_Get (new)
Description :  Get an asset on a sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/assets/{assetName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Assets_Create (new)
Description :  Create an asset on a sent share
Reference :  Link ¶

⚼ Request

PUT:  /sentShares/{sentShareName}/assets/{assetName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
asset:
{
Description: The asset payload to be created. ,
Required: True ,
}
{
kind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
kind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
Assets_Delete (new)
Description :  Delete an asset on a sent share
Reference :  Link ¶

⚼ Request

DELETE:  /sentShares/{sentShareName}/assets/{assetName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
assetName:
{
Description: The name of the asset ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AssetMappings_List (new)
Description :  List asset mappings for a received share
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/{receivedShareName}/assetMappings
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: Types of asset mapping. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AssetMappings_Get (new)
Description :  Get an asset mapping for a received share
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/{receivedShareName}/assetMappings/{assetMappingName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
assetMappingName:
{
Description: The name of the asset mapping ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
kind:
{
Description: Types of asset mapping. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AssetMappings_Create (new)
Description :  Create an asset mapping on a received share
Reference :  Link ¶

⚼ Request

PUT:  /receivedShares/{receivedShareName}/assetMappings/{assetMappingName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
assetMappingName:
{
Description: The name of the asset mapping ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
assetMapping:
{
Description: The asset mapping payload. ,
Required: True ,
}
{
kind:
{
Description: Types of asset mapping. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
kind:
{
Description: Types of asset mapping. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (202)

{
kind:
{
Description: Types of asset mapping. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AssetMappings_Delete (new)
Description :  Delete an asset mapping for a received share
Reference :  Link ¶

⚼ Request

DELETE:  /receivedShares/{receivedShareName}/assetMappings/{assetMappingName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
assetMappingName:
{
Description: The name of the asset mapping ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedInvitations_List (new)
Description :  List received invitations
Reference :  Link ¶

⚼ Request

GET:  /receivedInvitations
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedInvitations_Get (new)
Description :  Get a received invitation
Reference :  Link ¶

⚼ Request

GET:  /receivedInvitations/{receivedInvitationName}
{
receivedInvitationName:
{
Description: Name of the received invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedInvitations_Reject (new)
Description :  Reject a received invitation
Reference :  Link ¶

⚼ Request

POST:  /receivedInvitations/{receivedInvitationName}:reject
{
receivedInvitationName:
{
Description: Name of the received invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
receivedInvitation:
{
Description: The received invitation to reject ,
Required: True ,
}
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedShares_List (new)
Description :  List received shares
Reference :  Link ¶

⚼ Request

GET:  /receivedShares
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedShares_Get (new)
Description :  Get a received share
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/{receivedShareName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedShares_Create (new)
Description :  Create a received share
Reference :  Link ¶

⚼ Request

PUT:  /receivedShares/{receivedShareName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
receivedShare:
{
Description: The received share to create. ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedShares_Delete (new)
Description :  Delete a received share
Reference :  Link ¶

⚼ Request

DELETE:  /receivedShares/{receivedShareName}
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
ReceivedAssets_List (new)
Description :  List received assets for a received share
Reference :  Link ¶

⚼ Request

GET:  /receivedShares/{receivedShareName}/receivedAssets
{
receivedShareName:
{
Description: The name of the received share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
kind:
{
Description: The types of asset. ,
Enum:
{
AdlsGen2Account: No description available. ,
BlobAccount: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShares_List (new)
Description :  Get list of sent shares
Reference :  Link ¶

⚼ Request

GET:  /sentShares
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShares_Get (new)
Description :  Get a sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShares_CreateOrUpdate (new)
Description :  Create a sent share
Reference :  Link ¶

⚼ Request

PUT:  /sentShares/{sentShareName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
sentShare:
{
Description: The sent share payload ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShares_Delete (new)
Description :  Delete a sent share
Reference :  Link ¶

⚼ Request

DELETE:  /sentShares/{sentShareName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AcceptedSentShares_List (new)
Description :  Get list of accepted sent shares
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/acceptedSentShares
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AcceptedSentShares_Get (new)
Description :  Get an accepted sent share
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
acceptedSentShareName:
{
Description: The name of the accepted sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AcceptedSentShares_Reinstate (new)
Description :  Reinstate a revoked accepted sent share
Reference :  Link ¶

⚼ Request

POST:  /sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:reinstate
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
acceptedSentShareName:
{
Description: The name of the accepted sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
acceptedSentShare:
{
Description: The accepted sent share payload ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AcceptedSentShares_Revoke (new)
Description :  Revoke an accepted sent share
Reference :  Link ¶

⚼ Request

POST:  /sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:revoke
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
acceptedSentShareName:
{
Description: The name of the accepted sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
AcceptedSentShares_UpdateExpiration (new)
Description :  Update the expiration date of an accepted sent share
Reference :  Link ¶

⚼ Request

POST:  /sentShares/{sentShareName}/acceptedSentShares/{acceptedSentShareName}:update-expiration
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
acceptedSentShareName:
{
Description: The name of the accepted sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
acceptedSentShare:
{
Description: The accepted sent share payload ,
Required: True ,
}
{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
shareKind:
{
Description: Defines the supported types for share. ,
Enum:
{
InPlace: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShareInvitations_List (new)
Description :  List sent share invitations
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/sentShareInvitations
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
skipToken:
{
Description: The continuation token to list the next page ,
Required: False ,
}
string ,
$filter:
{
Description: Filters the results using OData syntax ,
Required: False ,
}
string ,
$orderby:
{
Description: Sorts the results using OData syntax ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The Url of next result page. ,
Required: False ,
}
string ,
value:
{
Description: Collection of items of type DataTransferObjects. ,
Required: True ,
}
[
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShareInvitations_Get (new)
Description :  Get a sent share invitation
Reference :  Link ¶

⚼ Request

GET:  /sentShares/{sentShareName}/sentShareInvitations/{sentShareInvitationName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
sentShareInvitationName:
{
Description: Name of the sent invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShareInvitations_CreateOrUpdate (new)
Description :  Create a sent share invitation
Reference :  Link ¶

⚼ Request

PUT:  /sentShares/{sentShareName}/sentShareInvitations/{sentShareInvitationName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
sentShareInvitationName:
{
Description: Name of the sent invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
sentShareInvitation:
{
Description: The sent share invitation to create ,
Required: True ,
}
{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (200)

{
invitationKind:
{
Description: The types of invitations. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
}
,
Required: True ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
SentShareInvitations_Delete (new)
Description :  Delete a sent share invitation
Reference :  Link ¶

⚼ Request

DELETE:  /sentShares/{sentShareName}/sentShareInvitations/{sentShareInvitationName}
{
sentShareName:
{
Description: The name of the sent share ,
Required: True ,
}
string ,
sentShareInvitationName:
{
Description: Name of the sent invitation ,
Required: True ,
}
string ,
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistration_Activate (new)
Description :  Activates the email registration for current tenant
Reference :  Link ¶

⚼ Request

POST:  /activateEmail
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
tenantEmailRegistration:
{
Description: The tenant email registration payload ,
Required: True ,
}
{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}
EmailRegistration_Register (new)
Description :  Register an email for the current tenant
Reference :  Link ¶

⚼ Request

POST:  /registerEmail
{
api-version:
{
Description: The api version to use. ,
Required: True ,
}
string ,
repeatability-request-id:
{
Description: If specified, the client directs that the request is repeatable; that is, that the client can make the request multiple times with the same Repeatability-Request-Id and get back an appropriate response without the server executing the request multiple times. The value of the Repeatability-Request-Id is an opaque string representing a client-generated, globally unique for all time, identifier for the request. It is recommended to use version 4 (random) UUIDs. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Tenant email registration property bag. ,
Required: False ,
}
{
activationCode:
{
Description: Activation code for the registration. ,
Required: True ,
}
string ,
activationExpiration:
{
Description: Date of the activation expiration. ,
Format: date-time ,
Required: False ,
}
string ,
email:
{
Description: The email to register. ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Defines the supported types for registration. ,
Enum:
{
ActivationPending: No description available. ,
Activated: No description available. ,
ActivationAttemptsExhausted: No description available. ,
}
,
Required: False ,
}
enum ,
tenantId:
{
Description: The tenant id to register. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The purview share error body model. ,
Required: True ,
}
{
code:
{
Description: Code of the error ,
Required: True ,
}
string ,
details:
{
Description: Nested details of the error model ,
Required: False ,
}
[
string ,
]
,
message:
{
Description: Message of the error ,
Required: True ,
}
string ,
target:
{
Description: Target of the error ,
Required: False ,
}
string ,
}
,
}